package org.dromara.system.domain;

import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;
import lombok.EqualsAndHashCode;
import org.dromara.common.core.constant.Constants;
import org.dromara.common.core.constant.UserConstants;
import org.dromara.common.core.utils.StringUtils;
import org.dromara.common.mybatis.core.domain.BaseEntity;

import java.util.ArrayList;
import java.util.List;


/**
 * @Author 刘武贵
 * @Date 2024/8/15 22:00
 * @Description 功能描述：菜单权限表 sys_menu
 */
@Data
@EqualsAndHashCode(callSuper = true)
@TableName("sys_menu")
public class SysMenu extends BaseEntity {

    /**
     * 菜单ID
     */
    @TableId(value = "menu_id")
    private Long menuId;

    /**
     * 父菜单ID
     */
    private Long parentId;

    /**
     * 菜单名称
     */
    private String menuName;

    /**
     * 显示顺序
     */
    private Integer orderNum;

    /**
     * 路由地址
     */
    private String path;

    /**
     * 组件路径
     */
    private String component;

    /**
     * 路由参数
     */
    private String queryParam;

    /**
     * 是否为外链（0是 1否）
     */
    private String isFrame;

    /**
     * 是否缓存（0缓存 1不缓存）
     */
    private String isCache;

    /**
     * 类型（M目录 C菜单 F按钮）
     */
    private String menuType;

    /**
     * 显示状态（0显示 1隐藏）
     */
    private String visible;

    /**
     * 菜单状态（0正常 1停用）
     */
    private String status;

    /**
     * 权限字符串
     */
    private String perms;

    /**
     * 菜单图标
     */
    private String icon;

    /**
     * 备注
     */
    private String remark;

    /**
     * 父菜单名称
     */
    @TableField(exist = false)
    private String parentName;

    /**
     * 子菜单
     */
    @TableField(exist = false)
    private List<SysMenu> children = new ArrayList<>();

    /**
     * 获取路由名称
     *
     * 本方法旨在根据路径生成路由名称如果路径对应的是一个目录且不是外部链接，
     * 并且该目录被框架包含，则返回空字符串；否则，返回路径的首字母大写形式
     *
     * @return 路由名称，可能为空字符串
     */
    public String getRouteName() {
        // 将路径首字母大写，以符合路由命名规范
        String routerName = StringUtils.capitalize(path);
        // 非外链并且是一级目录（类型为目录）
        if (isMenuFrame()) {
            // 若是框架内的一级目录，则其不作为独立路由，设置名称为空
            routerName = StringUtils.EMPTY;
        }
        return routerName;
    }

    /**
     * 获取路由地址
     *
     * 此方法用于计算和返回菜单项的路由路径。根据菜单项的属性，如是否为内链、父级ID、菜单类型和外框设置，
     * 方法会进行不同的路径处理，以确保路由路径的正确性。
     * @return 计算后的路由路径
     */
    public String getRouterPath() {
        String routerPath = this.path;
        // 内链打开外网方式
        if (getParentId() != 0L && isInnerLink()) {
            routerPath = innerLinkReplaceEach(routerPath);
        }
        // 非外链并且是一级目录（类型为目录）
        if (0L == getParentId() && UserConstants.TYPE_DIR.equals(getMenuType())
            && UserConstants.NO_FRAME.equals(getIsFrame())) {
            routerPath = "/" + this.path;
        }
        // 非外链并且是一级目录（类型为菜单）
        else if (isMenuFrame()) {
            routerPath = "/";
        }
        return routerPath;
    }

    /**
     * 获取组件信息
     */
    public String getComponentInfo() {
        // 默认组件信息，Layout组件标识
        String component = UserConstants.LAYOUT;
        // 如果自定义组件非空且不为菜单内部跳转，则使用自定义组件
        if (StringUtils.isNotEmpty(this.component) && !isMenuFrame()) {
            component = this.component;
            // 如果自定义组件为空、父ID不为0且为内链组件，则使用InnerLink组件标识
        } else if (StringUtils.isEmpty(this.component) && getParentId() != 0L && isInnerLink()) {
            // InnerLink组件标识
            component = UserConstants.INNER_LINK;
        } else if (StringUtils.isEmpty(this.component) && isParentView()) {
            // 如果自定义组件为空且为为parent_view组件，则ParentView组件标识
            component = UserConstants.PARENT_VIEW;
        }
        return component;
    }

    /**
     * 是否为菜单内部跳转
     * 判断当前菜单是否为菜单框架
     *
     * 此方法用于确定当前菜单对象是否属于顶级菜单并且是菜单类型，同时不是框架内嵌页面
     * 顶级菜单的判断基于父ID为0L，菜单类型为菜单（而非目录或按钮等），且不是内嵌框架页面
     * 这一判断通常用于菜单管理系统中，以区分不同层级和类型的菜单项
     *
     * @return boolean 返回是否为菜单框架
     */
    public boolean isMenuFrame() {
        // 父级ID为0且菜单类型（菜单）并且是菜单类型（菜单）并且为外链（0是 1否）
        return getParentId() == 0L && UserConstants.TYPE_MENU.equals(menuType) && isFrame.equals(UserConstants.NO_FRAME);
    }

    /**
     * 是否为内链组件
     * 判断当前链接是否为内链
     * 内链是指不属于框架内并且路径以"http://"或"https://"开头的链接
     *
     * @return boolean 返回true表示是内链，返回false表示不是内链
     */
    public boolean isInnerLink() {
        // 判断是否菜单外链并且是否为http(s)://开头
        return isFrame.equals(UserConstants.NO_FRAME) && StringUtils.ishttp(path);
    }

    /**
     * 是否为parent_view组件
     * 检查当前菜单项是否为父视图
     * <p>
     * 该方法通过判断菜单项的parentId和menuType来确定其是否为父视图
     * 父视图的条件是parentId不为0（表示不是根节点）且menuType等于TYPE_DIR（表示是一个目录）
     * 这种设计用于区分菜单项是目录（父视图）还是叶子节点（如具体的菜单项）
     *
     * @return 如果当前菜单项是父视图，则返回true；否则返回false
     */
    public boolean isParentView() {
        // 检查菜单项是否是目录类型且具有父节点并且是否是菜单类型（目录）
        return getParentId() != 0L && UserConstants.TYPE_DIR.equals(menuType);
    }

    /**
     * 内链域名特殊字符替换
     *
     * @param path 原始路径字符串，可以包含需要被替换的指定字符串
     * @return 替换后的路径字符串，其中特定的模式被移除或替换为分隔符，以符合内部链接的要求
     */
    public static String innerLinkReplaceEach(String path) {
        // 使用StringUtils.replaceEach方法，将path中的特定模式替换为指定的新字符串
        // 需要替换的模式包括HTTP、HTTPS、WWW协议前缀，以及句点和冒号分隔符
        // 替换后的结果是移除了协议前缀，并将句点和冒号替换为斜杠，以适应内部链接的格式
        return StringUtils.replaceEach(path, new String[]{Constants.HTTP, Constants.HTTPS, Constants.WWW, ".", ":"},
            new String[]{"", "", "", "/", "/"});
    }
}
